UpdateAddress

The UpdateAddress web service XML- or JSON-based information exchange systems that use the Internet for direct application-to-application interaction. These systems can include programs, objects, messages, or documents. enables an external client system to update address information for all levels of the CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. hierarchy.

This service should be used in conjunction with the Address subset of the following services:

The user A person with the capability to log in to the CMP GUI software, such as a customer service advisor or agent. must pass an identifier for the appropriate level of the hierarchy in order to update the address details.

If an address is the same at all levels of the CMP hierarchy and the user changes the address at one particular level, the address at all the other levels also change.

Address Request

The Address tag instructs the Address Service to update the address. This request contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	The client may use this identifier to correlate the request and the response.	Optional
AddressData	Container	See AddressData Container for details.	Mandatory
AuditRecord	Container	See AuditRecord Request Container for details.	Optional

AddressData Request Container

The AddressData request container contains the following elements:

Element Name	Content Type	Description	Required?
AddressNumber	String69	Obtained by issuing a Query Subscription request.	Mandatory
Address	Container	Choice of: PersonalAddress BusinessAddress	Mandatory
LastAmendedDate	dateTime	YYYY-MM-DDZ The date and time that the record was last changed.	Mandatory

Element Name

Content Type

Description

Required?

AddressNumber

String69

Obtained by issuing a Query Subscription request.

Mandatory

Address

Container

Choice of:

PersonalAddress
BusinessAddress

Mandatory

LastAmendedDate

dateTime

YYYY-MM-DDZ
The date and time that the record was last changed.

Mandatory

PersonalAddress Request Container

The PersonalAddress request container has the following elements:

Element Name	Content Type	Description	Required?
Title	String10	The customer's appropriate title for example Mr, Mrs, Miss, Ms or Dr. This field is always mandatory but can be made optional via configuration if required.	Mandatory
Forename	String50	Customer's first name.	Mandatory
MiddleName	String20	Customer's middle name.	Optional
Surname	String50	Customer's surname.	Mandatory
Address1	String60	Line one of the customer's address.	Mandatory
Address2	String60	Line one of the customer's address.	Optional
Address3	String60	Line one of the customer's address.	Optional
Address4	String60	Line one of the customer's address.	Optional
Address5	String60	Line one of the customer's address.	Optional
Postcode	String10	Customer's post code. Must be entered without spaces.	Optional
DateOfBirth	Date	Customer's date of birth, in the format YYYY-MM-DD. The user can also clear the current date of birth set by specifying CLEAR_FIELD.	Optional
Gender	String	Choice of: Male, Female, Unknown or BLANK.	Optional
MaritalStatus	String	Choice of: Married, Single, Widowed, Divorced, Other, Seperated or BLANK.	Optional
DateOfResidence	Date	The date from which the customer has lived at the address specified, in the format YYYY-MM-DD.	Optional
CustomerType	String10	Selected from one of the available Customer Types configured in CMP.	Optional
AddressType	String10	Identifies if the customer is a home owner, renting, living with parents, council tenant etc. Configurable CMP list.	Optional
AddressCategory	String10	Indicates property value. A category range relating to the address. Configurable CMP list.	Optional
Occupation	String10	The customer's current occupation. Configurable CMP list.	Optional
IDType	String10	The available type of ID used as proof of identity for example passport or driving license. Configurable CMP list.	Optional
IDNumber	String30	The unique ID from the proof of identity.	Optional
TelephoneNumber	String15	Customer's main contact telephone number.	Optional
EveningTelephoneNumber	String15	Customer's additional telephone number they can be reached on.	Optional
FaxNumber	String15	Customer's fax number.	Optional

CMP configuration controls which elements are mandatory and optional. Standard validation settings can be changed via setup: DISESETUP > 5. Subscriber Registration Set up > 15. Delivery Address Set Up > 8. Field Validation Maintenance. Enter 'P' for Personal Address.

BusinessAddress Request Container

The BusinessAddress request container has the following elements:

Element Name	Content Type	Description	Required?
CompanyName	String60	Name of company.	Mandatory
Address1	String40	Line one of the company's address.	Mandatory
Address2	String40	Line two of the company's address.	Mandatory
Address3	String40	Line three of the company's address.	Mandatory
Address4	String40	Line four of the company's address.	Optional
Address5	String40	Line five of the company's address.	Optional
Postcode	String10	Company's postcode. Must be entered without spaces.	Optional
CompanyTelephoneNumber	String15	Company's main contact telephone number.	Optional
ContactTelephoneNumber	String15	The individual's contact telephone number.	Optional
FaxNumber	String15	Company's fax number	Optional
CompanyType	String10	Indicates the type of company. Configurable CMP list.	Optional
AddressType	String10	Identifies the company's address. Configurable CMP list.	Optional
AddressCategory	String10	Indicates property value. A category range relating to the address can be configured. Configurable CMP list.	Optional
IndustrialClassificationCode	String10	Indicates the industry the company resides. Configurable CMP list.	Optional
CompanyRegistration	String25	Unique ID the company is registered to.	Optional
DateOfIncorporation	Date	The date the company register at the address specified, in the format YYYY-MM-DD.	Optional
Title	String10	Company's contact title.	Optional
Forename	String15	Company's contact first name.	Optional
MiddleName	String10	Company's contact middle name.	Optional
Surname	String25	Company's contact surname name.	Optional
JobTitle	String30	Company's contact job title.	Optional

AuditRecord Request Container

The AuditRecord request container has the following elements:

Element Name	Content Type	Description	Required?
UserID	String10	User ID associated with the profile. This is the ID which the calling program adds to the records that are created.	Mandatory
Program	String10	The Program Name should be hard coded in the calling application to uniquely identify that application.	Mandatory

UpdateAddress Response

UpdateAddress response is the response to the UpdateAddress Request. This contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	Returned unmodified in the response. The client may use this identifier to correlate the request and the response.	Optional